<!-- HTML header for doxygen 1.8.8-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
    <head>
        <meta http-equiv="X-UA-Compatible" content="IE=edge">
        <!-- For Mobile Devices -->
        <meta name="viewport" content="width=device-width, initial-scale=1">
        <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
        <meta name="generator" content="Doxygen 1.8.18"/>
        <script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
        <title>HElib: helib::CubeSignature Class Reference</title>
        <!--<link href="tabs.css" rel="stylesheet" type="text/css"/>-->
        <script type="text/javascript" src="dynsections.js"></script>
        <link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
        <link href="doxygen.css" rel="stylesheet" type="text/css" />
        <link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
        <link href='https://fonts.googleapis.com/css?family=Roboto+Slab' rel='stylesheet' type='text/css'>
		<link href="https://fonts.googleapis.com/css2?family=IBM+Plex+Sans:ital,wght@0,100;1,700&family=Merriweather&family=Merriweather+Sans&family=Open+Sans&family=Poppins:ital@1&family=Roboto:ital,wght@0,400;1,300;1,900&display=swap" rel="stylesheet"> 
        <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css">
        <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/js/bootstrap.min.js"></script>
        <link href="jquery.smartmenus.bootstrap.css" rel="stylesheet">
        <script type="text/javascript" src="jquery.smartmenus.js"></script>
        <!-- SmartMenus jQuery Bootstrap Addon -->
        <script type="text/javascript" src="jquery.smartmenus.bootstrap.js"></script>
        <!-- SmartMenus jQuery plugin -->
    </head>
    <body style="font-family: 'Merriweather', serif;">
        <nav class="navbar navbar-default" role="navigation">
            <div class="container">
                <div class="navbar-header">
                    <a class="navbar-brand">HElib Implementing Homomorphic Encryption</a>
                </div>
            </div>
        </nav>
        <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
            <div class="content" id="content">
                <div class="container">
                    <div class="row">
                        <div class="col-sm-12 panel " style="padding-bottom: 15px;">
                            <div style="margin-bottom: 15px;">
<!-- end header part -->
<!-- Generated by Doxygen 1.8.18 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespacehelib.html">helib</a></li><li class="navelem"><a class="el" href="classhelib_1_1_cube_signature.html">CubeSignature</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classhelib_1_1_cube_signature-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">helib::CubeSignature Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Holds a vector of dimensions for a hypercube and some additional data.  
 <a href="classhelib_1_1_cube_signature.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="hypercube_8h_source.html">hypercube.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a35bb466664c8bda4f00b46ce2a88135e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_cube_signature.html#a35bb466664c8bda4f00b46ce2a88135e">CubeSignature</a> ()</td></tr>
<tr class="separator:a35bb466664c8bda4f00b46ce2a88135e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a703f1b99c86044a134a2c2dd7811c57c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_cube_signature.html#a703f1b99c86044a134a2c2dd7811c57c">initSignature</a> (const long _dims[], long _ndims)</td></tr>
<tr class="separator:a703f1b99c86044a134a2c2dd7811c57c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3a8903128d694618cfbd29efbf78712"><td class="memTemplParams" colspan="2">template&lt;typename VecType &gt; </td></tr>
<tr class="memitem:aa3a8903128d694618cfbd29efbf78712"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classhelib_1_1_cube_signature.html#aa3a8903128d694618cfbd29efbf78712">initSignature</a> (const VecType &amp;_dims)</td></tr>
<tr class="separator:aa3a8903128d694618cfbd29efbf78712"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa627edae51d699afbd7ea557e735887"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_cube_signature.html#afa627edae51d699afbd7ea557e735887">CubeSignature</a> (const long _dims[], long _ndims)</td></tr>
<tr class="separator:afa627edae51d699afbd7ea557e735887"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4be2eaae3cdf78778fe6455c36912880"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_cube_signature.html#a4be2eaae3cdf78778fe6455c36912880">CubeSignature</a> (const NTL::Vec&lt; long &gt; &amp;_dims)</td></tr>
<tr class="separator:a4be2eaae3cdf78778fe6455c36912880"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0fb57f65fb46394e528cf00b5230b0ff"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_cube_signature.html#a0fb57f65fb46394e528cf00b5230b0ff">CubeSignature</a> (const std::vector&lt; long &gt; &amp;_dims)</td></tr>
<tr class="separator:a0fb57f65fb46394e528cf00b5230b0ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd2fddff2c0cdde6cb621f6c4bd75d78"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_cube_signature.html#acd2fddff2c0cdde6cb621f6c4bd75d78">getNumDims</a> () const</td></tr>
<tr class="memdesc:acd2fddff2c0cdde6cb621f6c4bd75d78"><td class="mdescLeft">&#160;</td><td class="mdescRight">number of dimensions  <a href="classhelib_1_1_cube_signature.html#acd2fddff2c0cdde6cb621f6c4bd75d78">More...</a><br /></td></tr>
<tr class="separator:acd2fddff2c0cdde6cb621f6c4bd75d78"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a77519f21f1fb6f9ceaaf5143f1dec93b"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_cube_signature.html#a77519f21f1fb6f9ceaaf5143f1dec93b">getSize</a> () const</td></tr>
<tr class="memdesc:a77519f21f1fb6f9ceaaf5143f1dec93b"><td class="mdescLeft">&#160;</td><td class="mdescRight">total size of cube  <a href="classhelib_1_1_cube_signature.html#a77519f21f1fb6f9ceaaf5143f1dec93b">More...</a><br /></td></tr>
<tr class="separator:a77519f21f1fb6f9ceaaf5143f1dec93b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e0d8be6c51758a86680d3f0f3063606"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_cube_signature.html#a1e0d8be6c51758a86680d3f0f3063606">getDim</a> (long d) const</td></tr>
<tr class="memdesc:a1e0d8be6c51758a86680d3f0f3063606"><td class="mdescLeft">&#160;</td><td class="mdescRight">size of dimension d  <a href="classhelib_1_1_cube_signature.html#a1e0d8be6c51758a86680d3f0f3063606">More...</a><br /></td></tr>
<tr class="separator:a1e0d8be6c51758a86680d3f0f3063606"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a246a8c53d93ec750140cf253e8b41174"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_cube_signature.html#a246a8c53d93ec750140cf253e8b41174">getProd</a> (long d) const</td></tr>
<tr class="memdesc:a246a8c53d93ec750140cf253e8b41174"><td class="mdescLeft">&#160;</td><td class="mdescRight">product of sizes of dimensions d, d+1, ...  <a href="classhelib_1_1_cube_signature.html#a246a8c53d93ec750140cf253e8b41174">More...</a><br /></td></tr>
<tr class="separator:a246a8c53d93ec750140cf253e8b41174"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a95fd54e2404c6bb86e0db54d0509530b"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_cube_signature.html#a95fd54e2404c6bb86e0db54d0509530b">getProd</a> (long from, long to) const</td></tr>
<tr class="memdesc:a95fd54e2404c6bb86e0db54d0509530b"><td class="mdescLeft">&#160;</td><td class="mdescRight">product of sizes of dimensions from, from+1, ..., to-1  <a href="classhelib_1_1_cube_signature.html#a95fd54e2404c6bb86e0db54d0509530b">More...</a><br /></td></tr>
<tr class="separator:a95fd54e2404c6bb86e0db54d0509530b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a950ef5b64163f211dd54c7d4489d3aa2"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_cube_signature.html#a950ef5b64163f211dd54c7d4489d3aa2">getCoord</a> (long i, long d) const</td></tr>
<tr class="memdesc:a950ef5b64163f211dd54c7d4489d3aa2"><td class="mdescLeft">&#160;</td><td class="mdescRight">get coordinate in dimension d of index i  <a href="classhelib_1_1_cube_signature.html#a950ef5b64163f211dd54c7d4489d3aa2">More...</a><br /></td></tr>
<tr class="separator:a950ef5b64163f211dd54c7d4489d3aa2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a503ba4e37bb66427add82ef13a72ab00"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_cube_signature.html#a503ba4e37bb66427add82ef13a72ab00">addCoord</a> (long i, long d, long offset) const</td></tr>
<tr class="memdesc:a503ba4e37bb66427add82ef13a72ab00"><td class="mdescLeft">&#160;</td><td class="mdescRight">add offset to coordinate in dimension d of index i  <a href="classhelib_1_1_cube_signature.html#a503ba4e37bb66427add82ef13a72ab00">More...</a><br /></td></tr>
<tr class="separator:a503ba4e37bb66427add82ef13a72ab00"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07dafff8898d869fdf4cda00aea5453a"><td class="memTemplParams" colspan="2">template&lt;typename VecType &gt; </td></tr>
<tr class="memitem:a07dafff8898d869fdf4cda00aea5453a"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classhelib_1_1_cube_signature.html#a07dafff8898d869fdf4cda00aea5453a">incrementCoords</a> (VecType &amp;v) const</td></tr>
<tr class="separator:a07dafff8898d869fdf4cda00aea5453a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac3aba8f9b2c33bff60c489c048ce0f0"><td class="memTemplParams" colspan="2">template&lt;typename VecType &gt; </td></tr>
<tr class="memitem:aac3aba8f9b2c33bff60c489c048ce0f0"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classhelib_1_1_cube_signature.html#aac3aba8f9b2c33bff60c489c048ce0f0">getAllCoords</a> (VecType &amp;v, long i) const</td></tr>
<tr class="separator:aac3aba8f9b2c33bff60c489c048ce0f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5141c50fbbb80c5101614f826d1405e3"><td class="memTemplParams" colspan="2">template&lt;typename VecType &gt; </td></tr>
<tr class="memitem:a5141c50fbbb80c5101614f826d1405e3"><td class="memTemplItemLeft" align="right" valign="top">long&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classhelib_1_1_cube_signature.html#a5141c50fbbb80c5101614f826d1405e3">assembleCoords</a> (VecType &amp;v) const</td></tr>
<tr class="separator:a5141c50fbbb80c5101614f826d1405e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae3b3e6e4fdefec7e372ecbefca124b44"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_cube_signature.html#ae3b3e6e4fdefec7e372ecbefca124b44">numSlices</a> (long d=1) const</td></tr>
<tr class="memdesc:ae3b3e6e4fdefec7e372ecbefca124b44"><td class="mdescLeft">&#160;</td><td class="mdescRight">number of slices  <a href="classhelib_1_1_cube_signature.html#ae3b3e6e4fdefec7e372ecbefca124b44">More...</a><br /></td></tr>
<tr class="separator:ae3b3e6e4fdefec7e372ecbefca124b44"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afdf761640cffa14fc956ec9832f2d2c8"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_cube_signature.html#afdf761640cffa14fc956ec9832f2d2c8">sliceSize</a> (long d=1) const</td></tr>
<tr class="memdesc:afdf761640cffa14fc956ec9832f2d2c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">size of one slice  <a href="classhelib_1_1_cube_signature.html#afdf761640cffa14fc956ec9832f2d2c8">More...</a><br /></td></tr>
<tr class="separator:afdf761640cffa14fc956ec9832f2d2c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40d654d1f59cf7c85acc69dae9b22e5a"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_cube_signature.html#a40d654d1f59cf7c85acc69dae9b22e5a">numCols</a> () const</td></tr>
<tr class="memdesc:a40d654d1f59cf7c85acc69dae9b22e5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">number of columns  <a href="classhelib_1_1_cube_signature.html#a40d654d1f59cf7c85acc69dae9b22e5a">More...</a><br /></td></tr>
<tr class="separator:a40d654d1f59cf7c85acc69dae9b22e5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a52ab718393d2c41b96b000948adc6e0b"><td class="memItemLeft" align="right" valign="top">std::pair&lt; long, long &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_cube_signature.html#a52ab718393d2c41b96b000948adc6e0b">breakIndexByDim</a> (long idx, long dim) const</td></tr>
<tr class="separator:a52ab718393d2c41b96b000948adc6e0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94042541a4cc00ed145b38c77a65ebac"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_cube_signature.html#a94042541a4cc00ed145b38c77a65ebac">assembleIndexByDim</a> (std::pair&lt; long, long &gt; idx, long dim) const</td></tr>
<tr class="memdesc:a94042541a4cc00ed145b38c77a65ebac"><td class="mdescLeft">&#160;</td><td class="mdescRight">The inverse of breakIndexByDim.  <a href="classhelib_1_1_cube_signature.html#a94042541a4cc00ed145b38c77a65ebac">More...</a><br /></td></tr>
<tr class="separator:a94042541a4cc00ed145b38c77a65ebac"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a73fef36c3f0bda715b5e8cdf847227c3"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_cube_signature.html#a73fef36c3f0bda715b5e8cdf847227c3">operator&lt;&lt;</a> (std::ostream &amp;s, const <a class="el" href="classhelib_1_1_cube_signature.html">CubeSignature</a> &amp;sig)</td></tr>
<tr class="separator:a73fef36c3f0bda715b5e8cdf847227c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Holds a vector of dimensions for a hypercube and some additional data. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a35bb466664c8bda4f00b46ce2a88135e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35bb466664c8bda4f00b46ce2a88135e">&#9670;&nbsp;</a></span>CubeSignature() <span class="overload">[1/4]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">helib::CubeSignature::CubeSignature </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="afa627edae51d699afbd7ea557e735887"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afa627edae51d699afbd7ea557e735887">&#9670;&nbsp;</a></span>CubeSignature() <span class="overload">[2/4]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">helib::CubeSignature::CubeSignature </td>
          <td>(</td>
          <td class="paramtype">const long&#160;</td>
          <td class="paramname"><em>_dims</em>[], </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">long&#160;</td>
          <td class="paramname"><em>_ndims</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a4be2eaae3cdf78778fe6455c36912880"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4be2eaae3cdf78778fe6455c36912880">&#9670;&nbsp;</a></span>CubeSignature() <span class="overload">[3/4]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">helib::CubeSignature::CubeSignature </td>
          <td>(</td>
          <td class="paramtype">const NTL::Vec&lt; long &gt; &amp;&#160;</td>
          <td class="paramname"><em>_dims</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a0fb57f65fb46394e528cf00b5230b0ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0fb57f65fb46394e528cf00b5230b0ff">&#9670;&nbsp;</a></span>CubeSignature() <span class="overload">[4/4]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">helib::CubeSignature::CubeSignature </td>
          <td>(</td>
          <td class="paramtype">const std::vector&lt; long &gt; &amp;&#160;</td>
          <td class="paramname"><em>_dims</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a503ba4e37bb66427add82ef13a72ab00"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a503ba4e37bb66427add82ef13a72ab00">&#9670;&nbsp;</a></span>addCoord()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">long helib::CubeSignature::addCoord </td>
          <td>(</td>
          <td class="paramtype">long&#160;</td>
          <td class="paramname"><em>i</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">long&#160;</td>
          <td class="paramname"><em>d</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">long&#160;</td>
          <td class="paramname"><em>offset</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>add offset to coordinate in dimension d of index i </p>

</div>
</div>
<a id="a5141c50fbbb80c5101614f826d1405e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5141c50fbbb80c5101614f826d1405e3">&#9670;&nbsp;</a></span>assembleCoords()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename VecType &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">long helib::CubeSignature::assembleCoords </td>
          <td>(</td>
          <td class="paramtype">VecType &amp;&#160;</td>
          <td class="paramname"><em>v</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>reconstruct index from its coordinates VecType is either std::vector&lt;intType&gt; or <a class="el" href="namespace_n_t_l.html">NTL</a>:Vec&lt;intType&gt; </p>

</div>
</div>
<a id="a94042541a4cc00ed145b38c77a65ebac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a94042541a4cc00ed145b38c77a65ebac">&#9670;&nbsp;</a></span>assembleIndexByDim()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">long helib::CubeSignature::assembleIndexByDim </td>
          <td>(</td>
          <td class="paramtype">std::pair&lt; long, long &gt;&#160;</td>
          <td class="paramname"><em>idx</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">long&#160;</td>
          <td class="paramname"><em>dim</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The inverse of breakIndexByDim. </p>

</div>
</div>
<a id="a52ab718393d2c41b96b000948adc6e0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a52ab718393d2c41b96b000948adc6e0b">&#9670;&nbsp;</a></span>breakIndexByDim()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::pair&lt; long, long &gt; helib::CubeSignature::breakIndexByDim </td>
          <td>(</td>
          <td class="paramtype">long&#160;</td>
          <td class="paramname"><em>idx</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">long&#160;</td>
          <td class="paramname"><em>dim</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Break an index into the hypercube to index of the dimension-dim subcube and index inside that subcube. </p>

</div>
</div>
<a id="aac3aba8f9b2c33bff60c489c048ce0f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac3aba8f9b2c33bff60c489c048ce0f0">&#9670;&nbsp;</a></span>getAllCoords()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename VecType &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void helib::CubeSignature::getAllCoords </td>
          <td>(</td>
          <td class="paramtype">VecType &amp;&#160;</td>
          <td class="paramname"><em>v</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">long&#160;</td>
          <td class="paramname"><em>i</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>get the coordinates of index i in all dimensions. VecType is either std::vector&lt;intType&gt; or <a class="el" href="namespace_n_t_l.html">NTL</a>:Vec&lt;intType&gt; </p>

</div>
</div>
<a id="a950ef5b64163f211dd54c7d4489d3aa2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a950ef5b64163f211dd54c7d4489d3aa2">&#9670;&nbsp;</a></span>getCoord()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">long helib::CubeSignature::getCoord </td>
          <td>(</td>
          <td class="paramtype">long&#160;</td>
          <td class="paramname"><em>i</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">long&#160;</td>
          <td class="paramname"><em>d</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>get coordinate in dimension d of index i </p>

</div>
</div>
<a id="a1e0d8be6c51758a86680d3f0f3063606"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e0d8be6c51758a86680d3f0f3063606">&#9670;&nbsp;</a></span>getDim()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">long helib::CubeSignature::getDim </td>
          <td>(</td>
          <td class="paramtype">long&#160;</td>
          <td class="paramname"><em>d</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>size of dimension d </p>

</div>
</div>
<a id="acd2fddff2c0cdde6cb621f6c4bd75d78"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd2fddff2c0cdde6cb621f6c4bd75d78">&#9670;&nbsp;</a></span>getNumDims()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">long helib::CubeSignature::getNumDims </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>number of dimensions </p>

</div>
</div>
<a id="a246a8c53d93ec750140cf253e8b41174"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a246a8c53d93ec750140cf253e8b41174">&#9670;&nbsp;</a></span>getProd() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">long helib::CubeSignature::getProd </td>
          <td>(</td>
          <td class="paramtype">long&#160;</td>
          <td class="paramname"><em>d</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>product of sizes of dimensions d, d+1, ... </p>

</div>
</div>
<a id="a95fd54e2404c6bb86e0db54d0509530b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95fd54e2404c6bb86e0db54d0509530b">&#9670;&nbsp;</a></span>getProd() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">long helib::CubeSignature::getProd </td>
          <td>(</td>
          <td class="paramtype">long&#160;</td>
          <td class="paramname"><em>from</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">long&#160;</td>
          <td class="paramname"><em>to</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>product of sizes of dimensions from, from+1, ..., to-1 </p>

</div>
</div>
<a id="a77519f21f1fb6f9ceaaf5143f1dec93b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a77519f21f1fb6f9ceaaf5143f1dec93b">&#9670;&nbsp;</a></span>getSize()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">long helib::CubeSignature::getSize </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>total size of cube </p>

</div>
</div>
<a id="a07dafff8898d869fdf4cda00aea5453a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07dafff8898d869fdf4cda00aea5453a">&#9670;&nbsp;</a></span>incrementCoords()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename VecType &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool helib::CubeSignature::incrementCoords </td>
          <td>(</td>
          <td class="paramtype">VecType &amp;&#160;</td>
          <td class="paramname"><em>v</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Increment the coordinates to point to next index, returning false if already at maximum value. VecType is either std::vector&lt;intType&gt; or <a class="el" href="namespace_n_t_l.html">NTL</a>:Vec&lt;intType&gt; </p>

</div>
</div>
<a id="a703f1b99c86044a134a2c2dd7811c57c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a703f1b99c86044a134a2c2dd7811c57c">&#9670;&nbsp;</a></span>initSignature() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void helib::CubeSignature::initSignature </td>
          <td>(</td>
          <td class="paramtype">const long&#160;</td>
          <td class="paramname"><em>_dims</em>[], </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">long&#160;</td>
          <td class="paramname"><em>_ndims</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="aa3a8903128d694618cfbd29efbf78712"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa3a8903128d694618cfbd29efbf78712">&#9670;&nbsp;</a></span>initSignature() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename VecType &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void helib::CubeSignature::initSignature </td>
          <td>(</td>
          <td class="paramtype">const VecType &amp;&#160;</td>
          <td class="paramname"><em>_dims</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a40d654d1f59cf7c85acc69dae9b22e5a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a40d654d1f59cf7c85acc69dae9b22e5a">&#9670;&nbsp;</a></span>numCols()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">long helib::CubeSignature::numCols </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>number of columns </p>

</div>
</div>
<a id="ae3b3e6e4fdefec7e372ecbefca124b44"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae3b3e6e4fdefec7e372ecbefca124b44">&#9670;&nbsp;</a></span>numSlices()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">long helib::CubeSignature::numSlices </td>
          <td>(</td>
          <td class="paramtype">long&#160;</td>
          <td class="paramname"><em>d</em> = <code>1</code></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>number of slices </p>

</div>
</div>
<a id="afdf761640cffa14fc956ec9832f2d2c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afdf761640cffa14fc956ec9832f2d2c8">&#9670;&nbsp;</a></span>sliceSize()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">long helib::CubeSignature::sliceSize </td>
          <td>(</td>
          <td class="paramtype">long&#160;</td>
          <td class="paramname"><em>d</em> = <code>1</code></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>size of one slice </p>

</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="a73fef36c3f0bda715b5e8cdf847227c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73fef36c3f0bda715b5e8cdf847227c3">&#9670;&nbsp;</a></span>operator&lt;&lt;</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::ostream&amp; operator&lt;&lt; </td>
          <td>(</td>
          <td class="paramtype">std::ostream &amp;&#160;</td>
          <td class="paramname"><em>s</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classhelib_1_1_cube_signature.html">CubeSignature</a> &amp;&#160;</td>
          <td class="paramname"><em>sig</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/HElib/include/helib/<a class="el" href="hypercube_8h_source.html">hypercube.h</a></li>
<li>/HElib/src/<a class="el" href="hypercube_8cpp.html">hypercube.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.8-->
<!-- start footer part -->
</div>
</div>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.18
</small></address>
</body>
        <script type="text/javascript" src="doxy-boot.js"></script>
</html>
